"""
@Project ：Python 
@File    ：05-函数的说明文档.py
@IDE     ：PyCharm 
@Author  ：DongCha
@Date    ：2023/11/7 0007 18:52 
"""

# 函数的说明文档可以辅助理解函数作用
# 基本语法：
# def 函数名(x, y):
#     """
#     函数说明
#     :param x: 参数说明
#     :param y: 参数说明
#     :return: 返回值说明
#     """
#     函数体
#     return 返回值
# 通过多行注释，对函数进行说明解释
# :param用来解释参数
# :return用来解释返回值
# 注意事项：
# 1.内容应该写在函数体之前


def add(x, y):
    """
    add函数接收两个参数，完成两数相加
    :param x: 表示相加的一个数字
    :param y: 表示相加的另一个参数
    :return: 返回值是两数相加的结果
    """
    result = x + y
    print(f"两数相加的结果是：{result}")
    return result


add(5, 6)
